Range

Function

This API is used to get the parameter range of Network > Cloud Service

Request Message

None.

Sample:

POST /API/NetworkConfig/CloudService/Range HTTP/1.1
{
    "version": "1.0",
    "data": {}
}

Response Message

Parameter Description

Table 1

ParameterRangeTypeDescription
cloud_switchboolCloud service switch
privacy_clause_switchboolPrivacy policy switch.
region"Afghanistan", "Åland Islands", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica",
"Antigua & Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahamas", "Bahrain",
"Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bosnia & Herzegovina",
"Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "British Virgin Islands", "Brunei", "Bulgaria",
"Burkina Faso", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Cayman Islands", "Central African Republic",
"Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Colombia", "Comoros", "Congo - Brazzaville",
"Congo - kinshasa", "Cook Islands", "Costa Rica", "Côte d'Ivoire", "Croatia", "Cuba", "Curaçao", "Cyprus", "Czechia", "Denmark",
"Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia",
"Eswatini", "Ethiopia", "Falkland Islands", "Faroe Islands", "Fiji", "Finland", "France", "French Guiana", "French Polynesia",
"French Southern Territories", "Gabon", "Gambia", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada",
"Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti",
"Heard Island and McDonald Islands", "Holy See", "Honduras", "Hong Kong,China", "Hungary", "Iceland", "India", "Indonesia",
"Iran", "Iraq", "Ireland", "Isle of Man", "Israel", "Italy", "Jamaica", "Japan", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati",
"Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg",
"Macao,China", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania",
"Mauritius", "Mayotte", "Mexico", "Micronesia", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco",
"Mozambique", "Myanmar (Burma)", "Namibia", "Nauru", "Nepal", "Netherlands", "New Caledonia", "New Zealand", "Nicaragua",
"Niger", "Nigeria", "Niue", "Norfolk Island", "North Macedonia", "Northern Mariana Islands", "Norway", "Oman", "Pakistan",
"Palau", "Palestine", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn", "Poland", "Portugal",
"Puerto Rico", "Qatar", "Réunion", "Romania", "Russian", "Rwanda", "Samoa", "San Marino", "Sao Tome & Principe",
"Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Maarten", "Slovakia", "Slovenia",
"So. Georgia & So. Sandwich Isl.", "Solomon Islands", "Somalia", "South Africa", "South Korea", "South Sudan", "Spain",
"Sri Lanka", "St. Barthélemy", "St. Helena", "St. Kitts & Nevis", "St. Lucia", "St. Martin", "St. Pierre & Miquelon",
"St. Vincent & Grenadines", "Sudan", "Suriname", "Svalbard & Jan Mayen", "Sweden", "Switzerland", "Syria", "Taiwan,China",
"Tajikistan", "Tanzania", "Thailand", "Timor-Leste", "Togo", "Tokelau", "Tonga", "Trinidad & Tobago", "Tunisia", "Turkey",
"Turkmenistan", "Turks & Caicos Islands", "Tuvalu", "U.S. Virgin Islands", "Uganda", "Ukraine", "United Arab Emirates",
"United Kingdom", "United States", "United States Minor Outlying Islands", "Uruguay", "Uzbekistan", "Vanuatu", "Venezuela",
"Vietnam", "Wallis & Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe", "CeShi"
stringarea.
status"NotActive" - not activated
"Creating" - Creating QR code
"CreatFailed" - QR code generation fails
"Effective" - QR code is valid
"Expire" - Qr code failure
"Bonud" - Device is bound
stringCloud device binding status
code_lifespan0-300intRemaining validity of QR code(s)
code_data0-256stringDynamic QR code: Customer code + country code + dynamic verification code + product code+cloud ID
例如:R:RPA00; G:XXX;M:H1AB; C:a00hdeikam2zinj; P:XXXXXX
bind_email0-256stringEmail address of the account bound to the device
agreement_privacy_flagboolThis field describes whether a privacy agreement has been configured.

Sample:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "result": "success",
    "data": {
        "cloud_switch": {
            "type": "bool"
        },
        "privacy_clause_switch": {
            "type": "bool"
        },
        "status": {
            "type": "string",
            "items": [
                "NotActive",
                "Creating",
                "CreatFailed",
                "Effective",
                "Expire",
                "Bonud"
            ]
        },
        "code_lifespan": {
            "type": "int32",
            "min": 0,
            "max": 300
        },
        "code_data": {
            "type": "string",
            "min_len": 0,
            "max_len": 256
        },
        "bind_email": {
            "type": "string",
            "min_len": 0,
            "max_len": 256
        },
        "region": {
            "type": "string",
            "items": [
                "Andorra",
                "United Arab Emirates",
                "Afghanistan",
                "Antigua & Barbuda",
                "Anguilla",
                "Albania",
                "Armenia",
                "Angola",
                "Antarctica",
                "Argentina",
                "American Samoa",
                "Austria",
                "Australia",
                "Aruba",
                "Åland Islands",
                "Azerbaijan",
                "Bosnia & Herzegovina",
                "Barbados",
                "Bangladesh",
                "Belgium",
                "Burkina Faso",
                "Bulgaria",
                "Bahrain",
                "Burundi",
                "Benin",
                "St. Barthélemy",
                "Bermuda",
                "Brunei",
                "Bolivia",
                "Brazil",
                "Bahamas",
                "Bhutan",
                "Bouvet Island",
                "Botswana",
                "Belarus",
                "Belize",
                "Canada",
                "Cocos (Keeling) Islands",
                "Congo - kinshasa",
                "Central African Republic",
                "Congo - Brazzaville",
                "Switzerland",
                "Côte d'Ivoire",
                "Cook Islands",
                "Chile",
                "Cameroon",
                "China",
                "Colombia",
                "Costa Rica",
                "Cuba",
                "Cape Verde",
                "Curaçao",
                "Christmas Island",
                "Cyprus",
                "Czechia",
                "Germany",
                "Djibouti",
                "Denmark",
                "Dominica",
                "Dominican Republic",
                "Algeria",
                "Ecuador",
                "Estonia",
                "Egypt",
                "Western Sahara",
                "Eritrea",
                "Spain",
                "Ethiopia",
                "Finland",
                "Fiji",
                "Falkland Islands",
                "Micronesia",
                "Faroe Islands",
                "France",
                "Gabon",
                "United Kingdom",
                "Grenada",
                "Georgia",
                "French Guiana",
                "Guernsey",
                "Ghana",
                "Gibraltar",
                "Greenland",
                "Gambia",
                "Guinea",
                "Guadeloupe",
                "Equatorial Guinea",
                "Greece",
                "So. Georgia & So. Sandwich Isl.",
                "Guatemala",
                "Guam",
                "Guinea-Bissau",
                "Guyana",
                "Hong Kong,China",
                "Heard Island and McDonald Islands",
                "Honduras",
                "Croatia",
                "Haiti",
                "Hungary",
                "Indonesia",
                "Ireland",
                "Israel",
                "Isle of Man",
                "India",
                "British Indian Ocean Territory",
                "Iraq",
                "Iran",
                "Iceland",
                "Italy",
                "Jamaica",
                "Jordan",
                "Japan",
                "Kenya",
                "Kyrgyzstan",
                "Cambodia",
                "Kiribati",
                "Comoros",
                "St. Kitts & Nevis",
                "South Korea",
                "Kuwait",
                "Cayman Islands",
                "Kazakhstan",
                "Laos",
                "Lebanon",
                "St. Lucia",
                "Liechtenstein",
                "Sri Lanka",
                "Liberia",
                "Lesotho",
                "Lithuania",
                "Luxembourg",
                "Latvia",
                "Libya",
                "Morocco",
                "Monaco",
                "Moldova",
                "Montenegro",
                "St. Martin",
                "Madagascar",
                "Marshall Islands",
                "North Macedonia",
                "Mali",
                "Myanmar (Burma)",
                "Mongolia",
                "Macao,China",
                "Northern Mariana Islands",
                "Martinique",
                "Mauritania",
                "Montserrat",
                "Malta",
                "Mauritius",
                "Maldives",
                "Malawi",
                "Mexico",
                "Malaysia",
                "Mozambique",
                "Namibia",
                "New Caledonia",
                "Niger",
                "Norfolk Island",
                "Nigeria",
                "Nicaragua",
                "Netherlands",
                "Norway",
                "Nepal",
                "Niue",
                "New Zealand",
                "Oman",
                "Panama",
                "Peru",
                "French Polynesia",
                "Papua New Guinea",
                "Philippines",
                "Pakistan",
                "Poland",
                "St. Pierre & Miquelon",
                "Pitcairn",
                "Puerto Rico",
                "Palestine",
                "Portugal",
                "Palau",
                "Paraguay",
                "Qatar",
                "Réunion",
                "Romania",
                "Serbia",
                "Russian",
                "Rwanda",
                "Saudi Arabia",
                "Solomon Islands",
                "Seychelles",
                "Sudan",
                "Sweden",
                "Singapore",
                "St. Helena",
                "Slovenia",
                "Svalbard & Jan Mayen",
                "Slovakia",
                "Sierra Leone",
                "San Marino",
                "Senegal",
                "Somalia",
                "Suriname",
                "South Sudan",
                "Sao Tome & Principe",
                "El Salvador",
                "Sint Maarten",
                "Syria",
                "Eswatini",
                "Turks & Caicos Islands",
                "Chad",
                "French Southern Territories",
                "Togo",
                "Thailand",
                "Tajikistan",
                "Tokelau",
                "Timor-Leste",
                "Turkmenistan",
                "Tunisia",
                "Tonga",
                "Turkey",
                "Trinidad & Tobago",
                "Tuvalu",
                "Taiwan,China",
                "Tanzania",
                "Ukraine",
                "Uganda",
                "United States Minor Outlying Islands",
                "United States",
                "Uruguay",
                "Uzbekistan",
                "Holy See",
                "St. Vincent & Grenadines",
                "Venezuela",
                "British Virgin Islands",
                "U.S. Virgin Islands",
                "Vietnam",
                "Vanuatu",
                "Wallis & Futuna",
                "Samoa",
                "Yemen",
                "Mayotte",
                "South Africa",
                "Zambia",
                "Zimbabwe",
                "CeShi"
            ]
        }
    }
}

Error Code

See Response Messages Body and Common error_code for more information.